DigiOffice Gateway Web Services

IDB_4PSBC_Import_Bouwnummer

Import bouwnummer record vanuit 4PS

The following routes are available for this service:
POST	/api/4PSBC/ImportBouwnummer

import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Import bouwnummer record vanuit 4PS
*/
@Api(Description="Import bouwnummer record vanuit 4PS")
open class IDB_4PSBC_Import_Bouwnummer
{
    /**
    * Message header
    */
    @ApiMember(Description="Message header", IsRequired=true)
    var Header:Header? = null

    /**
    * Message data
    */
    @ApiMember(Description="Message data", IsRequired=true)
    var Data:Data_Bouwnummer? = null
}

open class Header
{
    /**
    * Inhoud van het bericht
    */
    @ApiMember(Description="Inhoud van het bericht")
    var Contains:String? = null

    /**
    * Datum aanmaak bericht
    */
    @ApiMember(Description="Datum aanmaak bericht")
    var Date:String? = null

    /**
    * ID voor het bericht
    */
    @ApiMember(Description="ID voor het bericht")
    var MessageID:String? = null

    /**
    * Verzender van het bericht
    */
    @ApiMember(Description="Verzender van het bericht")
    var Sender:String? = null
}

open class Data_Bouwnummer
{
    var systemId:UUID? = null
    var digiOfficeId:UUID? = null
    var projectId:UUID? = null
    var plotNo:String? = null
    var address:String? = null
    var address2:String? = null
    var postCode:String? = null
    var city:String? = null
    var countryRegionId:String? = null
    var systemModifiedBy:String? = null
    var companyName4ps:String? = null
}

open class IDB_4PSBC_Response_Bouwnummer
{
    /**
    * Header of the response
    */
    @ApiMember(Description="Header of the response", IsRequired=true)
    var Header:Header? = null

    /**
    * Response body
    */
    @ApiMember(Description="Response body", IsRequired=true)
    var Response:Response_Bouwnummer? = null
}

open class Response_Bouwnummer
{
    /**
    * Reponse status (Ok/Error)
    */
    @ApiMember(Description="Reponse status (Ok/Error)", IsRequired=true)
    var Status:String? = null

    /**
    * Errors summary
    */
    @ApiMember(Description="Errors summary")
    var Errors:String? = null

    /**
    * ID of the bouwnummer in DigiOffice
    */
    @ApiMember(Description="ID of the bouwnummer in DigiOffice", IsRequired=true)
    var DigiOfficeBouwnummerID:String? = null

    /**
    * GlobalID (digiOfficeId) of the bouwnummer in DigiOffice
    */
    @ApiMember(Description="GlobalID (digiOfficeId) of the bouwnummer in DigiOffice", IsRequired=true)
    var DigiOfficeGlobalID:UUID? = null
}

Kotlin IDB_4PSBC_Import_Bouwnummer DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/4PSBC/ImportBouwnummer HTTP/1.1 
Host: kpm_digiofficeapigateway.tbi.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Header: 
	{
		Contains: String,
		Date: String,
		MessageID: String,
		Sender: String
	},
	Data: 
	{
		systemId: 00000000-0000-0000-0000-000000000000,
		digiOfficeId: 00000000-0000-0000-0000-000000000000,
		plotNo: String,
		address: String,
		address2: String,
		postCode: String,
		city: String,
		countryRegionId: String,
		systemModifiedBy: String,
		companyName4ps: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Header: 
	{
		Contains: String,
		Date: String,
		MessageID: String,
		Sender: String
	},
	Response: 
	{
		Status: String,
		Errors: String,
		DigiOfficeBouwnummerID: String
	}
}